Skip to content

Conversation

@mattwthompson
Copy link
Member

@mattwthompson mattwthompson commented Dec 1, 2025

openforcefield/status#122

The key change is that Setuptools crawls for files in openff/toolkit/ instead of the root of the directory (current behavior). This means docs.conf.py is no longer packaged, which it shouldn't be.

@codecov
Copy link

codecov bot commented Dec 2, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.19%. Comparing base (10c2d5a) to head (990f0ff).
⚠️ Report is 2 commits behind head on main.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

pyproject.toml Outdated
find = {}
[tool.setuptools.packages.find]
include = [ 'openff.toolkit*' ]
exclude = [ 'openff.toolkit.data' ]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This prevents files in openff/toolkit/data from being included in Python and Conda packages by default. These files take up the more space the disk than the Python files defining the package itself (this can be turned off):

image

This may not be desired, and these lines offer control over what is and is not packaged

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the summary. Unfortunately I think this would prevent certain files needed for examples from being found by get_data_file_path, for example here:

"pdb_file_path = get_data_file_path(\"systems/test_systems/1_cyclohexane_1_ethanol.pdb\")\n",
, which would break our examples helper and possibly deployment tests that run examples which rely on get_data_file_path.

We could change the openff-toolkit-examples package to contain these files even though openff-toolkit-base wouldn't, or change the examples helper to fetch them, or prune these directories with more granularity, but I don't think the juice is worth the squeeze.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha, that seems fair

@mattwthompson mattwthompson marked this pull request as ready for review December 2, 2025 16:58
@mattwthompson mattwthompson requested a review from j-wags as a code owner December 2, 2025 16:58
@j-wags j-wags self-assigned this Dec 10, 2025
Copy link
Member

@j-wags j-wags left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, unfortunately we need to keep the data dir, but happy to take the packaging updates

pyproject.toml Outdated
find = {}
[tool.setuptools.packages.find]
include = [ 'openff.toolkit*' ]
exclude = [ 'openff.toolkit.data' ]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the summary. Unfortunately I think this would prevent certain files needed for examples from being found by get_data_file_path, for example here:

"pdb_file_path = get_data_file_path(\"systems/test_systems/1_cyclohexane_1_ethanol.pdb\")\n",
, which would break our examples helper and possibly deployment tests that run examples which rely on get_data_file_path.

We could change the openff-toolkit-examples package to contain these files even though openff-toolkit-base wouldn't, or change the examples helper to fetch them, or prune these directories with more granularity, but I don't think the juice is worth the squeeze.

pyproject.toml Outdated
find = {}
[tool.setuptools.packages.find]
include = [ 'openff.toolkit*' ]
exclude = [ 'openff.toolkit.data' ]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(blocking) Per my other comment

Suggested change
exclude = [ 'openff.toolkit.data' ]

@mattwthompson mattwthompson merged commit c109ae3 into main Dec 14, 2025
33 of 51 checks passed
@mattwthompson mattwthompson deleted the fix-package-data branch December 14, 2025 18:09
@j-wags j-wags restored the fix-package-data branch January 15, 2026 17:35
@j-wags j-wags deleted the fix-package-data branch January 15, 2026 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants